Add information about embedded registry #296
Conversation
manuelbuil
force-pushed
the
addEmbeddedReg
branch
from
4d9d1b1 to
4f8f0ee
Compare
docs/install/airgap.md
Outdated
| The Embedded Registry Mirror is available as an experimental feature as of January 2024 releases: v1.26.13+rke2r1, v1.27.10+rke2r1, v1.28.6+rke2r1, v1.29.1+rke2r1 | ||
| ::: | ||
|
|
||
| K3s includes an embedded distributed OCI-compliant registry mirror. |
There was a problem hiding this comment.
| K3s includes an embedded distributed OCI-compliant registry mirror. | |
| RKE2 includes an embedded distributed OCI-compliant registry mirror. |
There was a problem hiding this comment.
Great catch Derek, thanks!
docs/install/airgap.md
Outdated
| @@ -2,7 +2,7 @@ | |||
| title: Air-Gap Install | |||
| --- | |||
|
|
|||
| RKE2 can be installed in an air-gapped environment with two different methods. You can either deploy via the `rke2-airgap-images` tarball release artifact, or by using a private registry. | |||
| RKE2 can be installed in an air-gapped environment with three different methods. You can either deploy via the [rke2-airgap-images tarball release artifact](#tarball-method), by using a [private registry](#private-registry-method) or by using the [embedded registry mirror](#embedded-registry-mirror). | |||
There was a problem hiding this comment.
We can't install RKE2 via the embedded registry. It just makes the image pulls easier.
There was a problem hiding this comment.
Technically you can use the embedded registry to provide the rke2-runtime image as long as there is already another cluster member to pull it from. That is an important restriction. You'd need to airgap or private registry the first node, and then the rest can use the embedded mirror.
There was a problem hiding this comment.
That's what I wanted to reflect here because that's what we are suggesting to a customer. I'll add a bit more explanation to it, right now it's impossible to know for sure that we mean that
| --- | ||
|
|
||
| :::info Version Gate | ||
| The Embedded Registry Mirror is available as an experimental feature as of January 2024 releases: v1.26.13+rke2r1, v1.27.10+rke2r1, v1.28.6+rke2r1, v1.29.1+rke2r1 |
There was a problem hiding this comment.
We are going straight to GA with this feature.
| The Embedded Registry Mirror is available as an experimental feature as of January 2024 releases: v1.26.13+rke2r1, v1.27.10+rke2r1, v1.28.6+rke2r1, v1.29.1+rke2r1 | |
| The Embedded Registry Mirror is available as of December 2024 releases: <INSERT VERSIONS> |
There was a problem hiding this comment.
Maybe available as of X, GA as of Y?
| In order to enable the embedded registry mirror, server nodes must be started with the `--embedded-registry` flag, or with `embedded-registry: true` in the configuration file. | ||
| This option enables the embedded mirror for use on all nodes in the cluster. | ||
|
|
||
| When enabled at a cluster level, all nodes will host a local OCI registry on port 6443, |
There was a problem hiding this comment.
Double checking that this is true for RKE2, on port 6443?
There was a problem hiding this comment.
It's on the supervisor port. So 9345 for rke2.
manuelbuil
force-pushed
the
addEmbeddedReg
branch
from
4f8f0ee to
f863cd4
Compare
Signed-off-by: manuelbuil <[email protected]>
This PR: